home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / comm2 / toymen20.lha / ToyMenu / Docs / ToyMenu.doc < prev    next >
Text File  |  1995-12-16  |  16KB  |  456 lines
  1.          __                       __                  ________
  2.    _ ___/  \___       _______ ___/  \___      (d!)  _ \      /____
  3.     \\__    __/_______\_    /_\__    __/_________    \ \   _/    /_____
  4.       /     ¬\    _    /   / ¬\/     ¬\    _    /______/_  `    /  ,__/___ _
  5.      /        ·   /   /____,   \_      ·   /   /   _    /\_____/\___   .://
  6.     ·          \_____/   /______/       \_____/\   /   /     _ _   /    /
  7.                                                 \_____/         \______/
  8.  
  9.                           ·)^» ToyMenu v2.O «^(·
  10.  
  11.                   Conference Selector for DayDream v1.17
  12.  
  13.           Programmed by Joo/ToyTools with ASM-One v1.28 by T.F.A.
  14.  
  15.                          Introduction & Features
  16.                             Installation Help
  17.                               Configuration
  18.                            Prompt & Menu Usage
  19.                            Previews & Examples
  20.                           ToyMenu with ToyBytes
  21.                                The Credits
  22.                            Contacting ToyTools
  23.  
  24.  
  25.   Introduction
  26.  
  27.   I started coding this because there weren't any good joinconf doors for
  28.   DayDream and /X joiners couldn't use DayDream's abilities. There wasn't
  29.   much left for configuring in those /X doors either.
  30.  
  31.   So, ToyMenu is a replacement (or alternative) to DayDream's "J", "<" and
  32.   ">" commands.
  33.  
  34.   If no parameters are given to the "J" command, ToyMenu creates a listing
  35.   depending on your config. Then you use cursor keys, numbers or letters
  36.   to move in the menu. Pressing enter joins the conference.
  37.  
  38.   You can also replace the "<" and ">" commands. This will add some extra
  39.   abilities to those commands. See Online usage Usage}.
  40.  
  41.   Some features:
  42.  
  43.   o Very configurable.
  44.   o Cursor key conference selecting.
  45.   o You can take full advantage of DayDream's special control codes in the
  46.     background display.
  47.   o Able to use two listings in the menu.
  48.   o Able to color differently or hide those conferences which the user has
  49.     no access to.
  50.   o The menu selector can be changed to whatever you like.
  51.     You can create moving lightbars etc.
  52.   o You can use number or letters to display the conference numbers in
  53.     the menu. Letters can be used also in the commandline. Or if you want,
  54.     no numbers but only the name can be displayed in the menu.
  55.   o Able to use hotkeys when selecting from the menu.
  56.   o Replaces also the "<" and ">" commands and adds some new functions
  57.     to them.
  58.   o Able to skip "you have no access to this conference" text when using
  59.     direct commands (e.g. "J 2" or "<"), instead displays the menu!
  60.   o Has inactivity timeout.
  61.   o The conference names are read from Conferences.DAT but if you want to use
  62.     different names you can use a namelist which can replace all the names or
  63.     just some of them.
  64.   o Able to use relative conferences:
  65.     If your conference access is "__XX____..." (you have access to conferences
  66.     3 and 4), you have to use "J 3" or "J 4" to join them directly.
  67.     But if you use relative conferences, you can use "J 1" or "J 2".
  68.   o Is 100% assembly language and can be made resident.
  69.  
  70.  
  71.  
  72.   Installation
  73.  
  74.   I created a small script ("Install.script") which installs the files to
  75.   correct directories. Use it by double clicking it from Workbench.
  76.   You still need to add ToyMenu to DayDream's external commands.
  77.  
  78.   (ToyMenu doesn't use any hardcoded paths, so if you want, you can put the
  79.   files anywhere you like. Just remember to use correct paths in DayDream's
  80.   config and in the DreamUtils environment variable.)
  81.  
  82.   1. Copy "ToyMenu" to "Doors:". (DayDream:Doors/)
  83.  
  84.   2. Copy "ToyMenu.guide" to "DayDream:Docs/"
  85.  
  86.   3. Copy "ToyMenu.CFG" to your DayDream config directory. Usually this is
  87.      "DayDream:Configs/". ToyMenu reads the config path from the environment
  88.      variable called "DreamUtils" (ENV:DreamUtils).
  89.  
  90.   4. Copy "ToyMenu.GFX" to "DayDream:Display/[displaymode]/" directories.
  91.  
  92.      - Now you are able to test it. Run DayDream and use the "$" command:
  93.  
  94.        Enter door command line to run: Doors:ToyMenu %N
  95.  
  96.   5. If you like it, add ToyMenu to DayDream's external commands:
  97.  
  98. DOOR_COMMAND.. J
  99. DOOR_TYPE..... 1
  100. DOOR_SECURITY. 5
  101. DOOR_EXECUTE.. Doors:ToyMenu %N
  102. +
  103. DOOR_COMMAND.. <
  104. DOOR_TYPE..... 1
  105. DOOR_SECURITY. 5
  106. DOOR_EXECUTE.. Doors:ToyMenu %N
  107. +
  108. DOOR_COMMAND.. >
  109. DOOR_TYPE..... 1
  110. DOOR_SECURITY. 5
  111. DOOR_EXECUTE.. Doors:ToyMenu %N
  112.  
  113.   - You can make ToyMenu resident:
  114.  
  115.        Resident Doors:ToyMenu PURE
  116.  
  117.  
  118.   Configuration
  119.  
  120.   ToyMenu doesn't display any hardcoded copyright texts but please credit me
  121.   somewhere in the background display...
  122.  
  123.   The background image(s), "ToyMenu.GFX" and/or "ToyMenu.TXT", should be
  124.   in your displaymode directories ("DayDream:Display/ISO/" etc.).
  125.  
  126.   You can use DayDream's special control codes to create random displays,
  127.   display the user's name, local time etc.
  128.   You can also create own displays for different security levels.
  129.   E.g. "ToyMenu.210.GFX" to security level 210.
  130.  
  131.   The configuration file's name is "ToyMenu.CFG" and it should be in the
  132.   directory where you have your other DayDream configurations.
  133.   (usually this is DayDream:Configs/")
  134.   The path is read from the environment variable "DreamUtils".
  135.  
  136.   USE_TWO_ROWS
  137.   USE_LETTERS
  138.   USE_ZEROFILL
  139.   HIDE_CONFERENCES
  140.   SKIP_CONFERENCES
  141.   SKIP_JOINGRAPHICS
  142.   USE_HOTKEYS
  143.   RELATIVE_CONFS
  144.   ROW_1_X
  145.   ROW_1_Y
  146.   ROW_2_X
  147.   ROW_2_Y
  148.   SPACE_CHARACTERS
  149.   TIMEOUT_SECONDS
  150.   CURSOR_STRING
  151.   SELECTOR_ACCESS
  152.   SELECTOR_NOACCESS
  153.   SELECTOR_CLEANER
  154.   NUMBER_COLOR_1
  155.   NUMBER_COLOR_2
  156.   CONFERENCE_COLOR_1
  157.   CONFERENCE_COLOR_2
  158.   COMMANDROW_TEXT
  159.   CONFNAMES_FILE
  160.  
  161.  
  162.   USE_TWO_ROWS....... [Y/N]
  163.  
  164.   If you set USE_TWO_ROWS to Y, ToyMenu will create two rows in the menu.
  165.   The coordinatess of these rows can be controlled with the coordinate
  166.   options.
  167.  
  168.  
  169.   USE_LETTERS........ [Y/N/-]
  170.  
  171.   If you set USE_LETTERS to Y, ToyMenu will use letters instead of numbers
  172.   in the menu to display the conference numbers. If this options is "-",
  173.   nothing will be used to display the conference numbers.
  174.  
  175.   Letters don't correspond the real conference numbers! They are relative to
  176.   the current user (e.g. letters always start with an "a" and continues
  177.   forward in order although there were hided conferences).
  178.  
  179.   Using letters in direct mode, "J n", works only with 26 first conferences.
  180.   This is because DayDream converts the door parameters to uppercase.
  181.   You can still use numbers in the commandline even if USE_LETTERS=Y.
  182.  
  183.   Example:
  184.  
  185.   USE_LETTERS........ N    -The user has no access to conf. 4 and the
  186.    01  New Users         HIDE_CONFERENCES option is Y.
  187.    02  Amiga Trade        or...
  188.    03  Modules            -There is no 4th conference.
  189.    05  DayDream Doors
  190.  
  191.   USE_LETTERS........ Y
  192.     a  New Users        -Note: a,b,c,d not a,b,c,e!
  193.     b  Amiga Trade
  194.     c  Modules
  195.     d  DayDream Doors
  196.  
  197.  
  198.   USE_ZEROFILL....... [Y/N]
  199.  
  200.   If USE_ZEROFILL is Y, the empty spaces in conference numbers will be
  201.   padded with zeros, e.g. "1" becomes "01". If you have more than 9
  202.   conferences, zerofill will be automatically used.
  203.  
  204.   If this is Y, you have to press two numbers to change the conference.
  205.  
  206.  
  207.   HIDE_CONFERENCES... [Y/N]
  208.  
  209.   If HIDE_CONFERENCES is Y, all conferences which the user has no access to,
  210.   will be hided (not displayed in the menu at all).
  211.  
  212.   I suggest that you set the USE_LETTERS or RELATIVE_CONFS option to Y when
  213.   hiding conferences!
  214.    
  215.  
  216.   SKIP_CONFERENCES... [Y/N]
  217.  
  218.   This option is for straight commandline usage only.
  219.  
  220.   E.g. the user types "J 2" and he has no access to conference 2.
  221.  
  222.   - If SKIP_CONFERENCES=N, "You have no access to that conference!" text
  223.     will be shown.
  224.  
  225.   - If SKIP_CONFERENCES=Y, the menu will be shown instead.
  226.  
  227.   Also affects the "<" and ">" commands so that if you are in the last conf
  228.   and use ">", the menu will be shown (or if you are in the first conf and
  229.   use "<"). Normally you can cycle confs with the "<" and ">" commands.
  230.  
  231.  
  232.   SKIP_JOINGRAPHICS.. [Y/N]
  233.  
  234.   If this is Y, "JoinConference.GFX" won't be shown when using direct
  235.   joining ("J 3", "<" etc.). When selecting from the menu, the graphics
  236.   will always be shown. This can be useful because first time users on your
  237.   board usually use the menu, but old users prefer fast commandline usage
  238.   And it's not fun to watch too long ANSI anims everytime you join your
  239.   favourite conference.
  240.  
  241.  
  242.   USE_HOTKEYS........ [Y/N]
  243.  
  244.   If this is Y, hotkeys will be used for conference selecting.
  245.   If this is N, the user has to press enter to select a conference.
  246.  
  247.  
  248.   RELATIVE_CONFS..... [Y/N]
  249.  
  250.   Examples:
  251.   If conference access is "__XX____..." (the user has access to conferences
  252.   3 and 4), he has to use "J 3" or "J 4" to join them directly.
  253.   But if RELATIVE_CONFS is Y, he can use "J 1" or "J 2".
  254.  
  255.   Example:
  256.  
  257.   RELATIVE_CONFS..... N        -The user has no access to conf. 4 and the
  258.    01  New Users         HIDE_CONFERENCES option is Y.
  259.    02  Amiga Trade        or...
  260.    03  Modules            -There is no 4th conference.
  261.    05  DayDream Doors
  262.  
  263.   RELATIVE_CONFS..... Y
  264.    01  New Users        -Note: 01,02,03,04 not 01,02,03,05!
  265.    02  Amiga Trade
  266.    03  Modules
  267.    04  DayDream Doors
  268.  
  269.   If you use this option, HIDE_CONFERENCES will automatically be "Y".
  270.  
  271.  
  272.   ROW_1_X............ [number]
  273.   ROW_1_Y............ [number]
  274.   ROW_2_X............ [number]
  275.   ROW_2_Y............ [number]
  276.  
  277.   These contain the coordinates of the menu rows.
  278.  
  279.  
  280.   SPACE_CHARACTERS... [number]
  281.  
  282.   How many characters between the conference number (or letter) and the
  283.   conference name in the menu listings.
  284.  
  285.  
  286.   TIMEOUT_SECONDS.... [number]
  287.  
  288.   Quit the menu after n seconds of inactivity. Put "-" here if you don't
  289.   want timeout. It's good to have a timeout, however, because DayDream's
  290.   internal timeout doesn't work in external doors.
  291.  
  292.  
  293.   CURSOR_STRING...... <ANSI-string>
  294.  
  295.   This string controls the place where the the cursor should be put.
  296.   Use ANSI codes to move and color it.
  297.  
  298.   Example: (Escapes removed)
  299.  
  300.   CURSOR_STRING...... [23;66H[32m
  301.  
  302.  
  303.   SELECTOR_ACCESS.... <string>
  304.   SELECTOR_NOACCESS.. <string>
  305.   SELECTOR_CLEANER... <string>
  306.  
  307.   In ToyMenu, selector means the image that moves in the menu.
  308.   With these options, you can design your own selector.
  309.  
  310.   SELECTOR_ACCESS is the menu selector image for conferences which the user
  311.   has access to.
  312.  
  313.   SELECTOR_NOACCESS is the selector for no-access conferences.
  314.  
  315.   SELECTOR_CLEANER is the menu selector "cleaner". It will be printed on
  316.   the old menu location. Remember to "jump" over the number (use ANSI
  317.   codes for this) etc.
  318.  
  319.   You can use conference names or letters in the selectors strings.
  320.   E.g. if you want to color the number or name where the selector is,
  321.   you have to use this. You can create a moving "light bar" etc.
  322.  
  323.   o Put "%N" in the string for number or letter.
  324.   o Put "%C" in the string for conference name.
  325.   o Put "%nC" in the string for conference name where n is the field
  326.     width. (e.g. "%20C")
  327.  
  328.   Example: (Escapes removed)
  329.  
  330.   SELECTOR_ACCESS.... [1D[44;37m %N  %15C [0m
  331.   SELECTOR_NOACCESS.. [1D[44;37m %N  %15C [0m
  332.   SELECTOR_CLEANER... [1D[0m %N  %15C [0m
  333.  
  334.  
  335.   NUMBER_COLOR_1..... <ANSI-string>
  336.   NUMBER_COLOR_2..... <ANSI-string>
  337.  
  338.   NUMBER_COLOR_1 is the color for the number or letter of the conference
  339.                  which the user has access to.
  340.  
  341.   NUMBER_COLOR_2 is the color for the number or letter of the conference
  342.                  which the user has no access to.
  343.  
  344.  
  345.   CONFERENCE_COLOR_1. <ANSI-string>
  346.   CONFERENCE_COLOR_2. <ANSI-string>
  347.  
  348.   CONFERENCE_COLOR_1 is the color for the conference which the user has
  349.                      access to.
  350.  
  351.   CONFERENCE_COLOR_2 is the color for the conference which the user has
  352.                      no access to.
  353.  
  354.  
  355.   COMMANDROW_TEXT.... <string>
  356.  
  357.   This is the text for the commandrow. Remember to use ANSI codes to place
  358.   the text in right place.
  359.  
  360.   If you want to use ranges, e.g. "01-05" or "a-e", you have to put
  361.   "%N" in your commandrow text.
  362.  
  363.   Example: (Escapes removed)
  364.  
  365.   COMMANDROW_TEXT.... [23;33HSelect conference (%N-%N, Q to QUIT): 
  366.  
  367.  
  368.   CONFNAMES_FILE..... [-/<filename>]
  369.  
  370.   This file contains your own names for the conferences.
  371.   If this is "-", names from Conferences.DAT will be used.
  372.  
  373.   Every line in the file corresponds one name. Remember to put a linefeed
  374.   after each name! You don't have to write own names for every conference!
  375.   You can use ANSI commands in these names.
  376.  
  377.   Example:
  378.  
  379.   -----cut here-----------------------------------------------cut here-----
  380.   Validation Zone
  381.  
  382.   DayDreaming
  383.   ToyTools
  384.   -----cut here-----------------------------------------------cut here-----
  385.  
  386.   Custom name for the 1st, 3rd and 4th conference but for the 2nd conference
  387.   the name from Conferences.DAT will be used.
  388.  
  389.  
  390.   Prompt & Menu Usage
  391.  
  392.   A simple "J" command shows the menu.
  393.   - If there's a number or letter behind it, access will be tested.
  394.   - If no access and SKIP_CONFERENCES=N, "You have no access..." text will
  395.     be displayed.
  396.   - If no access and SKIP_CONFERENCES=Y, ToyMenu will show the menu.
  397.   - If access is ok, conference will be joined. If SKIP_JOINGRAPHICS=Y,
  398.     no "JoinConference.GFX" won't be shown.
  399.  
  400.   MENU USAGE
  401.   o Use CURSOR KEYS, NUMBERS or LETTERS to move in the menu.
  402.     (depending on your config)
  403.   o Press ENTER to select a conference.
  404.     (if nothing happens, the user has no access to that conference)
  405.   o Press ESC (twice) or Q to quit the menu.
  406.     (or CTRL+Q when using letters mode)
  407.  
  408.   COMMANDLINE USAGE
  409.   o Use "J n" to join specific conference. E.g. "J 4" or "J d".
  410.     Note! If the letters option is "Y", you can use "J a" or "J b".
  411.     Because DayDream converts the parameters to uppercase, ToyMenu can
  412.     handle only characters a to z (enough for 26 conferences).
  413.   o Use "<" to join previous conference.
  414.   o Use "< n" to jump n conferences backwards.
  415.   o Use "< 0" to join the first conference.
  416.   o Use ">" to join next conference.
  417.   o Use "> n" to jump n conferences forward.
  418.   o Use "> 0" to join the last conference.
  419.  
  420.   You can cycle confs with the "<" and ">" commands. E.g. if you use "<" in
  421.   the first conf, you'll end up joining the last conf and vice versa.
  422.   (this doesn't work if SKIP_CONFERENCES=Y, instead it displays the menu)
  423.  
  424.  
  425.   The Credits
  426.  
  427.   hYDRA/iNSANE    Thanks for fixing the FetchKey() bug in DayDre... uh..
  428.                   I mean thanks for avoiding the bug in AmigaOS.
  429.                   (I never ever believed that there would still exist bugs in
  430.                   DayDream when I was trying to find that "seglist invalid"
  431.                   memory bug in ToyMenu =^) (Hi Allah)
  432.  
  433.   dUAL/iNSANE      Thanks for the ToyTools & other logos you made.
  434.                   I also robbed your "sentby"-design for my tools, hehe.
  435.  
  436.   zEUS/mST^sE!      Thanks for the design you made.
  437.                   (Check out ToyMenu.2.IFF)
  438.  
  439.   hIJACK/Arclite  Thanks for the conferences logo.
  440.                   (the one in the default display)
  441.  
  442.  
  443.               ... to contact ToyTools, you can call my board ...
  444.   _ _ _ __ _                                                       _ __ _ _ _
  445.      \\___ ____  __  ___  ___  ____ ____ ____ __ __ . ___  ____ ____ ___//
  446.         \_ \  /·(_/_·\__'·\  '·\__/·\  /·\__/·\ | /·|·\__'·\__/·\  / _/
  447.     _ _ _¦__ _                                                   _ __¦_ _ _
  448.        \\_      daydreaming on a123O/5Omhz/1Omb/2.1gb/v34/hydra      _//
  449.  -  - ---+-      amiga wares · programming · guitar · toytools      -+--- -  -
  450.          ¦:.                                                       .:¦
  451.          `----- -  -   -  - --> +358-72-5512972 <-- -  -   -  - -----'
  452.  
  453.                ... or send e-mail to joo@northstar.imagew.fi ...
  454.  
  455.  
  456.